<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="MediumAttributes,sandy.materials.attributes.MediumAttributes,blurAmount,fadeFrom,color,fadeTo" name="keywords">
<title>sandy.materials.attributes.MediumAttributes</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'MediumAttributes - Sandy 3.1.2 API Documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Sandy 3D Engine, 3.1.2</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?sandy/materials/attributes/MediumAttributes.html&amp;sandy/materials/attributes/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;MediumAttributes</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class MediumAttributes"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">sandy.materials.attributes</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public final  class MediumAttributes</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MediumAttributes <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="AAttributes.html">AAttributes</a></td>
</tr>
</table>
<p></p>
  This attribute provides very basic simulation of partially opaque medium.
  You can use this attribute to achieve wide range of effects (e.g., fog, Rayleigh scattering, light attached to camera, etc).
  
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProperty" id="hideInheritedProperty">
<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
</div>
<div class="showInheritedProperty" id="showInheritedProperty">
<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
</div>
</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#blurAmount">blurAmount</a> : Number<div class="summaryTableDescription">
   Maximum amount of blur to add.</div>
</td><td class="summaryTableOwnerCol">MediumAttributes</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#color">color</a> : uint<div class="summaryTableDescription">
   Medium color (32-bit value) at the point given by fadeFrom + fadeTo.</div>
</td><td class="summaryTableOwnerCol">MediumAttributes</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#fadeFrom">fadeFrom</a> : <a href="../../core/data/Point3D.html">Point3D</a>
<div class="summaryTableDescription">
   Transparent point in wx, wy and wz coordinates.</div>
</td><td class="summaryTableOwnerCol">MediumAttributes</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#fadeTo">fadeTo</a> : <a href="../../core/data/Point3D.html">Point3D</a>
<div class="summaryTableDescription">
   Attenuation Point3D.</div>
</td><td class="summaryTableOwnerCol">MediumAttributes</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="AAttributes.html#flags">flags</a> : uint<div class="summaryTableDescription">
  Returns the specific flags of this attribute.</div>
</td><td class="summaryTableOwnerCol"><a href="AAttributes.html">AAttributes</a></td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<div class="showHideLinks">
<div class="hideInheritedMethod" id="hideInheritedMethod">
<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
</div>
<div class="showInheritedMethod" id="showInheritedMethod">
<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
</div>
</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#MediumAttributes()">MediumAttributes</a>(p_nColor:uint = 0xFFFFFFFF, p_oFadeFrom:<a href="../../core/data/Point3D.html">Point3D</a> = null, p_oFadeTo:<a href="../../core/data/Point3D.html">Point3D</a> = null, p_nBlurAmount:Number = 0)</div>
<div class="summaryTableDescription">
   Creates a new MediumAttributes object.</div>
</td><td class="summaryTableOwnerCol">MediumAttributes</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AAttributes.html#begin()">begin</a>(p_oScene:<a href="../../core/Scene3D.html">Scene3D</a>):void</div>
<div class="summaryTableDescription">
  Method called before the display list rendering.</div>
</td><td class="summaryTableOwnerCol"><a href="AAttributes.html">AAttributes</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AAttributes.html#draw()">draw</a>(p_oGraphics:Graphics, p_oPolygon:<a href="../../core/data/Polygon.html">Polygon</a>, p_oMaterial:<a href="../../materials/Material.html">Material</a>, p_oScene:<a href="../../core/Scene3D.html">Scene3D</a>):void</div>
<div class="summaryTableDescription">
  Draws attribute to the graphics object.</div>
</td><td class="summaryTableOwnerCol"><a href="AAttributes.html">AAttributes</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AAttributes.html#drawOnSprite()">drawOnSprite</a>(p_oSprite:<a href="../../core/scenegraph/Sprite2D.html">Sprite2D</a>, p_oMaterial:<a href="../../materials/Material.html">Material</a>, p_oScene:<a href="../../core/Scene3D.html">Scene3D</a>):void</div>
<div class="summaryTableDescription">
  Applies attribute to a sprite.</div>
</td><td class="summaryTableOwnerCol"><a href="AAttributes.html">AAttributes</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AAttributes.html#finish()">finish</a>(p_oScene:<a href="../../core/Scene3D.html">Scene3D</a>):void</div>
<div class="summaryTableDescription">
  Method called right after the display list rendering.</div>
</td><td class="summaryTableOwnerCol"><a href="AAttributes.html">AAttributes</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AAttributes.html#init()">init</a>(p_oPolygon:<a href="../../core/data/Polygon.html">Polygon</a>):void</div>
<div class="summaryTableDescription">
  Allows to proceed to an initialization to know when the polyon isn't lined to the material.</div>
</td><td class="summaryTableOwnerCol"><a href="AAttributes.html">AAttributes</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AAttributes.html#unlink()">unlink</a>(p_oPolygon:<a href="../../core/data/Polygon.html">Polygon</a>):void</div>
<div class="summaryTableDescription">
  Remove all the initialization (opposite of init).</div>
</td><td class="summaryTableOwnerCol"><a href="AAttributes.html">AAttributes</a></td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="blurAmount"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">blurAmount</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>public var blurAmount:Number</code><p>
   Maximum amount of blur to add. <b>Warning:</b> this feature is very expensive when shape useSingleContainer is false.
   </p></div>
<a name="color"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">color</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>color:uint</code>&nbsp;&nbsp;[read-write]<p>
   Medium color (32-bit value) at the point given by fadeFrom + fadeTo.
   If this value is transparent, color gradient will be extrapolated beyond that point.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get color():uint</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set color(value:uint):void</code>
<br>
</div>
<a name="fadeFrom"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fadeFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var fadeFrom:<a href="../../core/data/Point3D.html">Point3D</a></code><p>
   Transparent point in wx, wy and wz coordinates.
      </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../../core/data/Point3D.html" target="">sandy.core.data.Point3D</a>
</div>
</div>
<a name="fadeTo"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fadeTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>fadeTo:<a href="../../core/data/Point3D.html">Point3D</a></code>&nbsp;&nbsp;[read-write]<p>
   Attenuation Point3D. This is the Point3D from transparent point to opaque point.
      </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get fadeTo():<a href="../../core/data/Point3D.html">Point3D</a></code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set fadeTo(value:<a href="../../core/data/Point3D.html">Point3D</a>):void</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../../core/data/Point3D.html" target="">sandy.core.data.Point3D</a>
</div>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="MediumAttributes()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">MediumAttributes</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function MediumAttributes(p_nColor:uint = 0xFFFFFFFF, p_oFadeFrom:<a href="../../core/data/Point3D.html">Point3D</a> = null, p_oFadeTo:<a href="../../core/data/Point3D.html">Point3D</a> = null, p_nBlurAmount:Number = 0)</code><p>
   Creates a new MediumAttributes object.
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">p_nColor</span>:uint</code> (default = <code>0xFFFFFFFF</code>)<code></code> &mdash;  Medium color
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">p_oFadeFrom</span>:<a href="../../core/data/Point3D.html">Point3D</a></code> (default = <code>null</code>)<code></code> &mdash;  Attenuation Point3D (500 pixels beyond the screen by default).
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">p_oFadeTo</span>:<a href="../../core/data/Point3D.html">Point3D</a></code> (default = <code>null</code>)<code></code> &mdash; Transparent point (at the screen by default).
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">p_nBlurAmount</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; Maximum amount of blur to add
      </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../../core/data/Point3D.html" target="">sandy.core.data.Point3D</a>
</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">API documentation for Sandy 3D Engine, Ver. 3.1.2</center>
</div>
</body>
</html>
<!--API documentation for Sandy 3D Engine, Ver. 3.1.2-->
